home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 26 / Cream of the Crop 26.iso / os2 / octa209s.zip / octave-2.09 / libs / readline / keymaps.h < prev    next >
C/C++ Source or Header  |  1996-12-14  |  4KB  |  108 lines
  1. /* Modified by Klaus Gebhardt, October 1996 */
  2. /* keymaps.h -- Manipulation of readline keymaps. */
  3.  
  4. /* Copyright (C) 1987, 1989, 1992 Free Software Foundation, Inc.
  5.  
  6.    This file is part of the GNU Readline Library, a library for
  7.    reading lines of text with interactive input and history editing.
  8.  
  9.    The GNU Readline Library is free software; you can redistribute it
  10.    and/or modify it under the terms of the GNU General Public License
  11.    as published by the Free Software Foundation; either version 1, or
  12.    (at your option) any later version.
  13.  
  14.    The GNU Readline Library is distributed in the hope that it will be
  15.    useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  16.    of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17.    GNU General Public License for more details.
  18.  
  19.    The GNU General Public License is often shipped with GNU software, and
  20.    is generally kept in a file called COPYING or LICENSE.  If you do not
  21.    have a copy of the license, write to the Free Software Foundation,
  22.    675 Mass Ave, Cambridge, MA 02139, USA. */
  23.  
  24. #ifndef _KEYMAPS_H_
  25. #define _KEYMAPS_H_
  26.  
  27. #ifdef __cplusplus
  28. extern "C" {
  29. #endif
  30.  
  31. #if defined (READLINE_LIBRARY)
  32. #  include "chardefs.h"
  33. #else
  34. #  include <chardefs.h>
  35. #endif
  36.  
  37. #if !defined (__FUNCTION_DEF)
  38. #  define __FUNCTION_DEF
  39. typedef int Function ();
  40. typedef void VFunction ();
  41. typedef char *CPFunction ();
  42. typedef char **CPPFunction ();
  43. #endif
  44.  
  45. /* A keymap contains one entry for each key in the ASCII set.
  46.    Each entry consists of a type and a pointer.
  47.    POINTER is the address of a function to run, or the
  48.    address of a keymap to indirect through.
  49.    TYPE says which kind of thing POINTER is. */
  50. typedef struct _keymap_entry {
  51.   char type;
  52.   Function *function;
  53. } KEYMAP_ENTRY;
  54.  
  55. /* This must be large enough to hold bindings for all of the characters
  56.    in a desired character set (e.g, 128 for ASCII, 256 for ISO Latin-x,
  57.    and so on). */
  58. #define KEYMAP_SIZE 256
  59.  
  60. /* I wanted to make the above structure contain a union of:
  61.    union { Function *function; struct _keymap_entry *keymap; } value;
  62.    but this made it impossible for me to create a static array.
  63.    Maybe I need C lessons. */
  64.  
  65. typedef KEYMAP_ENTRY KEYMAP_ENTRY_ARRAY[KEYMAP_SIZE];
  66. typedef KEYMAP_ENTRY *Keymap;
  67.  
  68. /* The values that TYPE can have in a keymap entry. */
  69. #define ISFUNC 0
  70. #define ISKMAP 1
  71. #define ISMACR 2
  72.  
  73. extern KEYMAP_ENTRY_ARRAY emacs_standard_keymap, emacs_meta_keymap, emacs_ctlx_keymap;
  74. #ifdef __EMX__
  75. extern KEYMAP_ENTRY_ARRAY emacs_emx_keymap;
  76. #endif
  77. extern KEYMAP_ENTRY_ARRAY vi_insertion_keymap, vi_movement_keymap;
  78.  
  79. /* Return a new, empty keymap.
  80.    Free it with free() when you are done. */
  81. extern Keymap rl_make_bare_keymap ();
  82.  
  83. /* Return a new keymap which is a copy of MAP. */
  84. extern Keymap rl_copy_keymap ();
  85.  
  86. /* Return a new keymap with the printing characters bound to rl_insert,
  87.    the lowercase Meta characters bound to run their equivalents, and
  88.    the Meta digits bound to produce numeric arguments. */
  89. extern Keymap rl_make_keymap ();
  90.  
  91. extern void rl_discard_keymap ();
  92.  
  93. /* Return the keymap corresponding to a given name.  Names look like
  94.    `emacs' or `emacs-meta' or `vi-insert'. */
  95. extern Keymap rl_get_keymap_by_name ();
  96.  
  97. /* Return the current keymap. */
  98. extern Keymap rl_get_keymap ();
  99.  
  100. /* Set the current keymap to MAP. */
  101. extern void rl_set_keymap ();
  102.  
  103. #ifdef __cplusplus
  104. }
  105. #endif
  106.  
  107. #endif /* _KEYMAPS_H_ */
  108.